Refactor: kebab-case the three snake_case doc filenames - #1528
Conversation
Every document under docs/ used kebab-case except three, which used underscores. Rename them and update every reference (paths below are relative to docs/): hierarchical_level_runtime.md -> hierarchical-level-runtime.md sim_multi_device_isolation.md -> sim-multi-device-isolation.md dfx/dep_gen.md -> dfx/dep-gen.md 64 reference occurrences across 30 files, including the ascend rule and the dfx-analyze skill under .claude/, the example READMEs, a pytest comment, and four C++ headers/sources that cite the dep_gen schema doc from a comment. The non-markdown files change only in those comments; no code is affected. Only the exact "<name>.md" strings were rewritten, so the code identifiers that share the dep_gen spelling are untouched: dep_gen.h, enable_dep_gen and dep_gen_host_graph still resolve, and no dep-gen_ typo was introduced. This does mean docs/dfx/dep-gen.md no longer mirrors the dep_gen identifier it documents; filename consistency was chosen over that correspondence, and the feature keeps its underscore spelling in prose and in link text. docs/README.md now states the kebab-case convention, including for docs named after an underscore-bearing identifier, so the exception does not come back. Renames are recorded as renames, so git log --follow still works. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
|
Warning Review limit reached
Next review available in: 7 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (33)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
1 participant
Summary
Every document under
docs/used kebab-case except three, which used underscores. This renames them and updates every reference:docs/hierarchical_level_runtime.mddocs/hierarchical-level-runtime.mddocs/dfx/dep_gen.mddocs/dfx/dep-gen.mddocs/sim_multi_device_isolation.mddocs/sim-multi-device-isolation.md64 occurrences across 30 files, including
.claude/rules/ascend.md,.claude/skills/dfx-analyze, theexamples/workers/READMEs, a pytest comment, and four C++ headers/sources that cite the dep_gen schema doc from a comment. The non-markdown files change only inside those comments — no code is affected.docs/README.mdnow states the convention so the exception does not come back.docs/hierarchical_level_runtime.md(alongside 16src/common/hierarchical/files). This rename will give that PR a rename-vs-modify conflict. It is the highest-inbound doc in the repo, so there is no version of this rename that avoids the collision — merging Feat: add launch-acceptance flight fence #1467 first and rebasing this PR is the cheaper order.src/a2a3/runtime/host_build_graph/host/dep_gen_host_graph.cpp, where this PR changes one comment line. Trivial, but it is a real overlap.I deliberately excluded
docs/logging.mdfrom the earlierdfx/consolidation for exactly this reason; here the collision is unavoidable if all three are to be renamed, so flagging rather than hiding it.Verification
docs/.mdsuffix<name>.mdstrings were rewritten, sodep_gen.h(13),enable_dep_gen(103) anddep_gen_host_graph(70) all still resolve, and a check for a mis-generateddep-gen_/dep-gen.hreturns 0markdownlint-cli2clean on all 29 changed markdown files, using v0.20.0 — the version.pre-commit-config.yaml:83pinsgitrecords all three as renames, sogit log --followkeeps workingNote on
dep_gen.mdIts underscore was not a typo — it mirrored the
dep_gen/enable_dep_gen/dep_gen_host_graphidentifiers. Renaming the doc breaks that correspondence, which I raised before doing it; filename consistency was chosen deliberately. The feature keeps its underscore spelling in prose, in link text, and in the doc's own H1, so only the filename changes.Testing
Documentation and comments only; no code, build, or config changes, so the sim/hardware suites do not apply per the git-commit skill's test matrix.